📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

• Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
• Use 2 spaces for indentation
• Use '1.' for all items in ordered lists (1/1/1 numbering style)
• Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
• Empty lines required before/after code blocks and headings (except before line 1)
• Escape backslashes in file paths only (not in code blocks)
• Code blocks must specify language identifiers

Text Formatting

• Parameters: bold
• Values/literals: inline code
• Resource/module/product names: italic
• Commands/files/paths: inline code

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

• Always update the Unreleased section in CHANGELOG.md
• Use Keep a Changelog format
• Describe notable changes briefly, ≤2 items per change type
• Reference issues using format issue #<issue_number>
• No empty lines between list items in same section
• Skip adding entry if same change already exists in Unreleased section
• No duplicate sections or items in Unreleased section

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

• Command: Public command
• Function: Private function
• Resource: DSC class-based resource

Build & Test Workflow Requirements

• Run PowerShell script files from repository root
• Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop
• Build project before running tests: ./build.ps1 -Tasks build
• Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

• Public commands: source/Public/{CommandName}.ps1
• Private functions: source/Private/{FunctionName}.ps1
• Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
• Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

• Follow instructions over existing code patterns
• Follow PowerShell style and test guideline instructions strictly
• Always update CHANGELOG.md Unreleased section
• Localize all strings using string keys; remove any orphaned string keys
• Check DscResource.Common before creating private functions
• Separate reusable logic into private functions
• DSC resources should always be created as class-based resources
• Add unit tests for all commands/functions/resources
• Add integration tests for all public commands and resources

Files:

• CHANGELOG.md
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-localization.instructions.md)

source/**/*.ps1: Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning, and $PSCmdlet.ThrowTerminatingError() messages
Use localized string keys instead of hardcoded strings in script output/messages
Assume and use $script:localizedData for accessing localized strings
When emitting messages, reference $script:localizedData.KeyName and format with the -f operator (e.g., Write-Verbose -Message ($script:localizedData.KeyName -f $value1))

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

source/**/*.ps1: # Localization Guidelines

Requirements

• Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning and $PSCmdlet.ThrowTerminatingError() messages
• Use localized string keys, not hardcoded strings
• Assume $script:localizedData is available

String Files

• Commands/functions: source/en-US/{MyModuleName}.strings.psd1
• Class resources: source/en-US/{ResourceClassName}.strings.psd1

Key Naming Patterns

• Format: Verb_FunctionName_Action (underscore separators), e.g. Get_Database_ConnectingToDatabase

String Format

ConvertFrom-StringData @'
    KeyName = Message with {0} placeholder. (PREFIX0001)
'@

String IDs

• Format: (PREFIX####)
• PREFIX: First letter of each word in class or function name (SqlSetup → SS, Get-SqlDscDatabase → GSDD)
• Number: Sequential from 0001

Usage

Write-Verbose -Message ($script:localizedData.KeyName -f $value1)

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Place public commands in source/Public/{CommandName}.ps1

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

• Use descriptive names (3+ characters, no abbreviations)
• Functions: PascalCase with Verb-Noun format using approved verbs
• Parameters: PascalCase
• Variables: camelCase
• Keywords: lower-case
• Classes: PascalCase
• Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

• Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

• Use 4 spaces (no tabs)
• One space around operators: $a = 1 + 2
• One space between type and variable: [String] $name
• One space between keyword and parenthesis: if ($condition)
• No spaces on empty lines
• Try to limit lines to 120 characters

Braces

• Newline before opening brace (except variable assignments)
• One newline after opening brace
• Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

• Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

• Single line: @('one', 'two', 'three')
• Multi-line: each element on separate line with proper indentation
• Do not use the unary comma operator (,) in return statements to force
  an array

Hashtables

• Empty: @{}
• Each property on separate line with proper indentation
• Properties: Use PascalCase

Comments

• Single line: # Comment (capitalized, on own line)
• Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text
• No commented-out code

Comment-based help

• Always add comment-based help to all functions and scripts
• Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class
• Comment-based help indentation: keywords 4 spaces, text 8 spaces
• Include examples for all parameter sets and combinations
• INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

• All public commands, private functions and classes must have unit tests
• All public commands and class-based resources must have integration tests
• Use Pester v5 syntax only
• Test code only inside Describe blocks
• Assertions only in It blocks
• Never test verbose messages, debug messages or parameter binding behavior
• Pass all mandatory parameters to avoid prompts

Requirements

• Inside It blocks, assign unused return objects to $null (unless part of pipeline)
• Tested entity must be called from within the It blocks
• Keep results and assertions in same It block
• Avoid try-catch-finally for cleanup, use AfterAll or AfterEach
• Avoid unnecessary remove/recreate cycles

Naming

• One Describe block per file matching the tested entity name
• Context descriptions start with 'When'
• It descriptions start with 'Should', must not contain 'when'
• Mock variables prefix: 'mock'

Structure & Scope

• Public commands: Never use InModuleScope (unless retrieving localized strings)
• Private functions/class resources: Always use InModuleScope
• Each class method = separate Context block
• Each scenario = separate Context block
• Use nested Context blocks for complex scenarios
• Mocking in BeforeAll (BeforeEach only when required)
• Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

• PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
• Use -BeTrue/-BeFalse never -Be $true/-Be $false
• Never use Assert-MockCalled, use Should -Invoke instead
• No Should -Not -Throw - invoke commands directly
• Never add an empty -MockWith block
• Omit -MockWith when returning $null
• Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName
• Omit -ModuleName parameter on Pester commands
• Never use Mock inside `InModuleSc...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

Public command unit tests must reside in tests/Unit/Public/{Name}.Tests.ps1

Place unit tests for public commands in tests/Unit/Public/{Name}.Tests.ps1

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md)

tests/[Uu]nit/**/*.[Tt]ests.ps1: In unit tests, access localized strings using InModuleScope -ScriptBlock { $script:localizedData.Key }
When mocking files in tests, use the $TestDrive variable for file system operations
All public commands must include parameter set validation tests
Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module
Use the provided Parameter Set Validation test template to assert command ParameterSetName and full parameter list string; for multiple parameter sets, supply multiple hashtables via -ForEach
Use the Parameter Properties template to assert a parameter is mandatory via $parameterInfo = (Get-Command -Name 'CommandName').Parameters['ParameterName']; $parameterInfo.Attributes.Mandatory | Should -BeTrue

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[Uu]nit/**/*.[Tt]ests.ps1: # Unit Tests Guidelines

• Test with localized strings: Use InModuleScope -ScriptBlock { $script:localizedData.Key }
• Mock files: Use $TestDrive variable (path to the test drive)
• All public commands require parameter set validation tests
• After modifying classes, always run tests in new session (for changes to take effect)

Test Setup Requirements

Use this exact setup block before Describe:

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'

    $PSDefaultParameterValues['InModuleScope:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Mock:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Should:ModuleName'] = $script:moduleName
}

AfterAll {
    $PSDefaultParameterValues.Remove('InModuleScope:ModuleName')
    $PSDefaultParameterValues.Remove('Mock:ModuleNam...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Add unit tests for all commands, functions, and resources

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : Use nested Context blocks for complex scenarios

Applied to files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

• All public commands, private functions and classes must have unit tests
• All public commands and class-based resources must have integration tests
• Use Pester v5 syntax only
• Test code only inside Describe blocks
• Assertions only in It blocks
• Never test verbose messages, debug messages or parameter binding behavior
• Pass all mandatory parameters to avoid prompts

Requirements

• Inside It blocks, assign unused return objects to $null (unless part of pipeline)
• Tested entity must be called from within the It blocks
• Keep results and assertions in same It block
• Avoid try-catch-finally for cleanup, use AfterAll or AfterEach
• Avoid unnecessary remove/recreate cycles

Naming

• One Describe block per file matching the tested entity name
• Context descriptions start with 'When'
• It descriptions start with 'Should', must not contain 'when'
• Mock variables prefix: 'mock'

Structure & Scope

• Public commands: Never use InModuleScope (unless retrieving localized strings)
• Private functions/class resources: Always use InModuleScope
• Each class method = separate Context block
• Each scenario = separate Context block
• Use nested Context blocks for complex scenarios
• Mocking in BeforeAll (BeforeEach only when required)
• Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

• PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
• Use -BeTrue/-BeFalse never -Be $true/-Be $false
• Never use Assert-MockCalled, use Should -Invoke instead
• No Should -Not -Throw - invoke commands directly
• Never add an empty -MockWith block
• Omit -MockWith when returning $null
• Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName
• Omit -ModuleName parameter on Pester commands
• Never use Mock inside `InModuleSc...

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
In CI, use Get-ComputerName for computer names
Avoid using ExpectedMessage with Should -Throw assertions
When invoking commands in integration tests, pass -Force where applicable to avoid prompts
Use -ErrorAction Stop on commands so failures surface immediately
At the top of each integration test file, include SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments') with an empty justification parameter and param ()
In BeforeDiscovery, ensure DscResource.Test is available; if not loaded or not available, run build.ps1 -Tasks 'noop' (suppressing non-error streams) and Import-Module 'DscResource.Test' -Force -ErrorAction Stop
Catch [System.IO.FileNotFoundException] during setup and throw: "DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first."
In BeforeAll, set $script:moduleName and Import-Module -Name $script:moduleName -Force -ErrorAction Stop

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

• Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
• Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
• No mocking - real environment only
• Cover all scenarios and code paths
• Use Get-ComputerName for computer names in CI
• Avoid ExpectedMessage for Should -Throw assertions
• Only run integration tests in CI unless explicitly instructed.
• Call commands with -Force parameter where applicable (avoids prompting).
• Use -ErrorAction Stop on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

• Command: Public command
• Function: Private function
• Resource: DSC class-based resource

Build & Test Workflow Requirements

• Run PowerShell script files from repository root
• Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop
• Build project before running tests: ./build.ps1 -Tasks build
• Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

• Public commands: source/Public/{CommandName}.ps1
• Private functions: source/Private/{FunctionName}.ps1
• Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
• Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

• Follow instructions over existing code patterns
• Follow PowerShell style and test guideline instructions strictly
• Always update CHANGELOG.md Unreleased section
• Localize all strings using string keys; remove any orphaned string keys
• Check DscResource.Common before creating private functions
• Separate reusable logic into private functions
• DSC resources should always be created as class-based resources
• Add unit tests for all commands/functions/resources
• Add integration tests for all public commands and resources

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• CHANGELOG.md

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

• Use descriptive names (3+ characters, no abbreviations)
• Functions: PascalCase with Verb-Noun format using approved verbs
• Parameters: PascalCase
• Variables: camelCase
• Keywords: lower-case
• Classes: PascalCase
• Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

• Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

• Use 4 spaces (no tabs)
• One space around operators: $a = 1 + 2
• One space between type and variable: [String] $name
• One space between keyword and parenthesis: if ($condition)
• No spaces on empty lines
• Try to limit lines to 120 characters

Braces

• Newline before opening brace (except variable assignments)
• One newline after opening brace
• Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

• Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

• Single line: @('one', 'two', 'three')
• Multi-line: each element on separate line with proper indentation
• Do not use the unary comma operator (,) in return statements to force
  an array

Hashtables

• Empty: @{}
• Each property on separate line with proper indentation
• Properties: Use PascalCase

Comments

• Single line: # Comment (capitalized, on own line)
• Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text
• No commented-out code

Comment-based help

• Always add comment-based help to all functions and scripts
• Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class
• Comment-based help indentation: keywords 4 spaces, text 8 spaces
• Include examples for all parameter sets and combinations
• INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

• tests/Integration/Commands/Add-SqlDscTraceFlag.Integration.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1
• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-localization.instructions.md)

source/**/*.ps1: Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning, and $PSCmdlet.ThrowTerminatingError() messages
Use localized string keys instead of hardcoded strings in script output/messages
Assume and use $script:localizedData for accessing localized strings
When emitting messages, reference $script:localizedData.KeyName and format with the -f operator (e.g., Write-Verbose -Message ($script:localizedData.KeyName -f $value1))

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

source/**/*.ps1: # Localization Guidelines

Requirements

• Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning and $PSCmdlet.ThrowTerminatingError() messages
• Use localized string keys, not hardcoded strings
• Assume $script:localizedData is available

String Files

• Commands/functions: source/en-US/{MyModuleName}.strings.psd1
• Class resources: source/en-US/{ResourceClassName}.strings.psd1

Key Naming Patterns

• Format: Verb_FunctionName_Action (underscore separators), e.g. Get_Database_ConnectingToDatabase

String Format

ConvertFrom-StringData @'
    KeyName = Message with {0} placeholder. (PREFIX0001)
'@

String IDs

• Format: (PREFIX####)
• PREFIX: First letter of each word in class or function name (SqlSetup → SS, Get-SqlDscDatabase → GSDD)
• Number: Sequential from 0001

Usage

Write-Verbose -Message ($script:localizedData.KeyName -f $value1)

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Place public commands in source/Public/{CommandName}.ps1

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

Public command unit tests must reside in tests/Unit/Public/{Name}.Tests.ps1

Place unit tests for public commands in tests/Unit/Public/{Name}.Tests.ps1

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md)

tests/[Uu]nit/**/*.[Tt]ests.ps1: In unit tests, access localized strings using InModuleScope -ScriptBlock { $script:localizedData.Key }
When mocking files in tests, use the $TestDrive variable for file system operations
All public commands must include parameter set validation tests
Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module
Use the provided Parameter Set Validation test template to assert command ParameterSetName and full parameter list string; for multiple parameter sets, supply multiple hashtables via -ForEach
Use the Parameter Properties template to assert a parameter is mandatory via $parameterInfo = (Get-Command -Name 'CommandName').Parameters['ParameterName']; $parameterInfo.Attributes.Mandatory | Should -BeTrue

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[Uu]nit/**/*.[Tt]ests.ps1: # Unit Tests Guidelines

• Test with localized strings: Use InModuleScope -ScriptBlock { $script:localizedData.Key }
• Mock files: Use $TestDrive variable (path to the test drive)
• All public commands require parameter set validation tests
• After modifying classes, always run tests in new session (for changes to take effect)

Test Setup Requirements

Use this exact setup block before Describe:

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'

    $PSDefaultParameterValues['InModuleScope:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Mock:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Should:ModuleName'] = $script:moduleName
}

AfterAll {
    $PSDefaultParameterValues.Remove('InModuleScope:ModuleName')
    $PSDefaultParameterValues.Remove('Mock:ModuleNam...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Add unit tests for all commands, functions, and resources

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

• Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
• Use 2 spaces for indentation
• Use '1.' for all items in ordered lists (1/1/1 numbering style)
• Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
• Empty lines required before/after code blocks and headings (except before line 1)
• Escape backslashes in file paths only (not in code blocks)
• Code blocks must specify language identifiers

Text Formatting

• Parameters: bold
• Values/literals: inline code
• Resource/module/product names: italic
• Commands/files/paths: inline code

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

• Always update the Unreleased section in CHANGELOG.md
• Use Keep a Changelog format
• Describe notable changes briefly, ≤2 items per change type
• Reference issues using format issue #<issue_number>
• No empty lines between list items in same section
• Skip adding entry if same change already exists in Unreleased section
• No duplicate sections or items in Unreleased section

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

• All public commands, private functions and classes must have unit tests
• All public commands and class-based resources must have integration tests
• Use Pester v5 syntax only
• Test code only inside Describe blocks
• Assertions only in It blocks
• Never test verbose messages, debug messages or parameter binding behavior
• Pass all mandatory parameters to avoid prompts

Requirements

• Inside It blocks, assign unused return objects to $null (unless part of pipeline)
• Tested entity must be called from within the It blocks
• Keep results and assertions in same It block
• Avoid try-catch-finally for cleanup, use AfterAll or AfterEach
• Avoid unnecessary remove/recreate cycles

Naming

• One Describe block per file matching the tested entity name
• Context descriptions start with 'When'
• It descriptions start with 'Should', must not contain 'when'
• Mock variables prefix: 'mock'

Structure & Scope

• Public commands: Never use InModuleScope (unless retrieving localized strings)
• Private functions/class resources: Always use InModuleScope
• Each class method = separate Context block
• Each scenario = separate Context block
• Use nested Context blocks for complex scenarios
• Mocking in BeforeAll (BeforeEach only when required)
• Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

• PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
• Use -BeTrue/-BeFalse never -Be $true/-Be $false
• Never use Assert-MockCalled, use Should -Invoke instead
• No Should -Not -Throw - invoke commands directly
• Never add an empty -MockWith block
• Omit -MockWith when returning $null
• Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName
• Omit -ModuleName parameter on Pester commands
• Never use Mock inside `InModuleSc...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

Public command unit tests must reside in tests/Unit/Public/{Name}.Tests.ps1

Place unit tests for public commands in tests/Unit/Public/{Name}.Tests.ps1

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md)

tests/[Uu]nit/**/*.[Tt]ests.ps1: In unit tests, access localized strings using InModuleScope -ScriptBlock { $script:localizedData.Key }
When mocking files in tests, use the $TestDrive variable for file system operations
All public commands must include parameter set validation tests
Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module
Use the provided Parameter Set Validation test template to assert command ParameterSetName and full parameter list string; for multiple parameter sets, supply multiple hashtables via -ForEach
Use the Parameter Properties template to assert a parameter is mandatory via $parameterInfo = (Get-Command -Name 'CommandName').Parameters['ParameterName']; $parameterInfo.Attributes.Mandatory | Should -BeTrue

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[Uu]nit/**/*.[Tt]ests.ps1: # Unit Tests Guidelines

• Test with localized strings: Use InModuleScope -ScriptBlock { $script:localizedData.Key }
• Mock files: Use $TestDrive variable (path to the test drive)
• All public commands require parameter set validation tests
• After modifying classes, always run tests in new session (for changes to take effect)

Test Setup Requirements

Use this exact setup block before Describe:

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'

    $PSDefaultParameterValues['InModuleScope:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Mock:ModuleName'] = $script:moduleName
    $PSDefaultParameterValues['Should:ModuleName'] = $script:moduleName
}

AfterAll {
    $PSDefaultParameterValues.Remove('InModuleScope:ModuleName')
    $PSDefaultParameterValues.Remove('Mock:ModuleNam...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Add unit tests for all commands, functions, and resources

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

• Command: Public command
• Function: Private function
• Resource: DSC class-based resource

Build & Test Workflow Requirements

• Run PowerShell script files from repository root
• Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop
• Build project before running tests: ./build.ps1 -Tasks build
• Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

• Public commands: source/Public/{CommandName}.ps1
• Private functions: source/Private/{FunctionName}.ps1
• Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
• Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

• Follow instructions over existing code patterns
• Follow PowerShell style and test guideline instructions strictly
• Always update CHANGELOG.md Unreleased section
• Localize all strings using string keys; remove any orphaned string keys
• Check DscResource.Common before creating private functions
• Separate reusable logic into private functions
• DSC resources should always be created as class-based resources
• Add unit tests for all commands/functions/resources
• Add integration tests for all public commands and resources

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• CHANGELOG.md
• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

• Use descriptive names (3+ characters, no abbreviations)
• Functions: PascalCase with Verb-Noun format using approved verbs
• Parameters: PascalCase
• Variables: camelCase
• Keywords: lower-case
• Classes: PascalCase
• Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

• Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

• Use 4 spaces (no tabs)
• One space around operators: $a = 1 + 2
• One space between type and variable: [String] $name
• One space between keyword and parenthesis: if ($condition)
• No spaces on empty lines
• Try to limit lines to 120 characters

Braces

• Newline before opening brace (except variable assignments)
• One newline after opening brace
• Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

• Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

• Single line: @('one', 'two', 'three')
• Multi-line: each element on separate line with proper indentation
• Do not use the unary comma operator (,) in return statements to force
  an array

Hashtables

• Empty: @{}
• Each property on separate line with proper indentation
• Properties: Use PascalCase

Comments

• Single line: # Comment (capitalized, on own line)
• Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text
• No commented-out code

Comment-based help

• Always add comment-based help to all functions and scripts
• Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class
• Comment-based help indentation: keywords 4 spaces, text 8 spaces
• Include examples for all parameter sets and combinations
• INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

• tests/Unit/Public/Add-SqlDscTraceFlag.Tests.ps1
• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

• Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
• Use 2 spaces for indentation
• Use '1.' for all items in ordered lists (1/1/1 numbering style)
• Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
• Empty lines required before/after code blocks and headings (except before line 1)
• Escape backslashes in file paths only (not in code blocks)
• Code blocks must specify language identifiers

Text Formatting

• Parameters: bold
• Values/literals: inline code
• Resource/module/product names: italic
• Commands/files/paths: inline code

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

• Always update the Unreleased section in CHANGELOG.md
• Use Keep a Changelog format
• Describe notable changes briefly, ≤2 items per change type
• Reference issues using format issue #<issue_number>
• No empty lines between list items in same section
• Skip adding entry if same change already exists in Unreleased section
• No duplicate sections or items in Unreleased section

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-localization.instructions.md)

source/**/*.ps1: Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning, and $PSCmdlet.ThrowTerminatingError() messages
Use localized string keys instead of hardcoded strings in script output/messages
Assume and use $script:localizedData for accessing localized strings
When emitting messages, reference $script:localizedData.KeyName and format with the -f operator (e.g., Write-Verbose -Message ($script:localizedData.KeyName -f $value1))

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

source/**/*.ps1: # Localization Guidelines

Requirements

• Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning and $PSCmdlet.ThrowTerminatingError() messages
• Use localized string keys, not hardcoded strings
• Assume $script:localizedData is available

String Files

• Commands/functions: source/en-US/{MyModuleName}.strings.psd1
• Class resources: source/en-US/{ResourceClassName}.strings.psd1

Key Naming Patterns

• Format: Verb_FunctionName_Action (underscore separators), e.g. Get_Database_ConnectingToDatabase

String Format

ConvertFrom-StringData @'
    KeyName = Message with {0} placeholder. (PREFIX0001)
'@

String IDs

• Format: (PREFIX####)
• PREFIX: First letter of each word in class or function name (SqlSetup → SS, Get-SqlDscDatabase → GSDD)
• Number: Sequential from 0001

Usage

Write-Verbose -Message ($script:localizedData.KeyName -f $value1)

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Place public commands in source/Public/{CommandName}.ps1

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

• Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
• Use 2 spaces for indentation
• Use '1.' for all items in ordered lists (1/1/1 numbering style)
• Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
• Empty lines required before/after code blocks and headings (except before line 1)
• Escape backslashes in file paths only (not in code blocks)
• Code blocks must specify language identifiers

Text Formatting

• Parameters: bold
• Values/literals: inline code
• Resource/module/product names: italic
• Commands/files/paths: inline code

Files:

• CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

• Always update the Unreleased section in CHANGELOG.md
• Use Keep a Changelog format
• Describe notable changes briefly, ≤2 items per change type
• Reference issues using format issue #<issue_number>
• No empty lines between list items in same section
• Skip adding entry if same change already exists in Unreleased section
• No duplicate sections or items in Unreleased section

Files:

• CHANGELOG.md

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

• Command: Public command
• Function: Private function
• Resource: DSC class-based resource

Build & Test Workflow Requirements

• Run PowerShell script files from repository root
• Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop
• Build project before running tests: ./build.ps1 -Tasks build
• Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

• Public commands: source/Public/{CommandName}.ps1
• Private functions: source/Private/{FunctionName}.ps1
• Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
• Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

• Follow instructions over existing code patterns
• Follow PowerShell style and test guideline instructions strictly
• Always update CHANGELOG.md Unreleased section
• Localize all strings using string keys; remove any orphaned string keys
• Check DscResource.Common before creating private functions
• Separate reusable logic into private functions
• DSC resources should always be created as class-based resources
• Add unit tests for all commands/functions/resources
• Add integration tests for all public commands and resources

Files:

• CHANGELOG.md
• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-localization.instructions.md)

source/**/*.ps1: Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning, and $PSCmdlet.ThrowTerminatingError() messages
Use localized string keys instead of hardcoded strings in script output/messages
Assume and use $script:localizedData for accessing localized strings
When emitting messages, reference $script:localizedData.KeyName and format with the -f operator (e.g., Write-Verbose -Message ($script:localizedData.KeyName -f $value1))

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

source/**/*.ps1: # Localization Guidelines

Requirements

• Localize all Write-Debug, Write-Verbose, Write-Error, Write-Warning and $PSCmdlet.ThrowTerminatingError() messages
• Use localized string keys, not hardcoded strings
• Assume $script:localizedData is available

String Files

• Commands/functions: source/en-US/{MyModuleName}.strings.psd1
• Class resources: source/en-US/{ResourceClassName}.strings.psd1

Key Naming Patterns

• Format: Verb_FunctionName_Action (underscore separators), e.g. Get_Database_ConnectingToDatabase

String Format

ConvertFrom-StringData @'
    KeyName = Message with {0} placeholder. (PREFIX0001)
'@

String IDs

• Format: (PREFIX####)
• PREFIX: First letter of each word in class or function name (SqlSetup → SS, Get-SqlDscDatabase → GSDD)
• Number: Sequential from 0001

Usage

Write-Verbose -Message ($script:localizedData.KeyName -f $value1)

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Place public commands in source/Public/{CommandName}.ps1

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

• source/Public/Add-SqlDscTraceFlag.ps1

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

• Use descriptive names (3+ characters, no abbreviations)
• Functions: PascalCase with Verb-Noun format using approved verbs
• Parameters: PascalCase
• Variables: camelCase
• Keywords: lower-case
• Classes: PascalCase
• Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

• Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

• Use 4 spaces (no tabs)
• One space around operators: $a = 1 + 2
• One space between type and variable: [String] $name
• One space between keyword and parenthesis: if ($condition)
• No spaces on empty lines
• Try to limit lines to 120 characters

Braces

• Newline before opening brace (except variable assignments)
• One newline after opening brace
• Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

• Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

• Single line: @('one', 'two', 'three')
• Multi-line: each element on separate line with proper indentation
• Do not use the unary comma operator (,) in return statements to force
  an array

Hashtables

• Empty: @{}
• Each property on separate line with proper indentation
• Properties: Use PascalCase

Comments

• Single line: # Comment (capitalized, on own line)
• Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text
• No commented-out code

Comment-based help

• Always add comment-based help to all functions and scripts
• Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class
• Comment-based help indentation: keywords 4 spaces, text 8 spaces
• Include examples for all parameter sets and combinations
• INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

• source/Public/Add-SqlDscTraceFlag.ps1